<!doctype html>
<html>
    <head>
        <title>HT 菜单手册</title>
        <meta charset="UTF-8">    
        <meta name="viewport" content="user-scalable=yes, width=1024">
        <style type="text/css"> 
            h1, h2, h3, h4, h5, h6, p, blockquote {
                margin: 0;
                padding: 0;
            }
            body {
                font-family: "Helvetica Neue", Helvetica, "Hiragino Sans GB", Arial, sans-serif;
                font-size: 13px;
                line-height: 18px;
                color: #737373;
                background-color: white; 
                margin: 10px 13px 10px 13px;
            }
            table {
                margin: 10px 0 15px 0;
                border-collapse: collapse;
            }
            td,th {	
                border: 1px solid #ddd;
                padding: 3px 10px;
            }
            th {
                padding: 5px 10px;	
            }
            a {
                color: #0069d6;
            }
            a:hover {
                color: #0050a3;
                text-decoration: none;
            }
            a img {
                border: none;
            }
            p {
                margin-bottom: 9px;
            }
            h1, h2, h3, h4, h5, h6 {
                color: #404040;
                line-height: 36px;
            }
            h1 {
                margin-bottom: 18px;
                font-size: 30px;
            }
            h2 {
                font-size: 24px;
            }
            h3 {
                font-size: 18px;
            }
            h4 {
                font-size: 16px;
            }
            h5 {
                font-size: 14px;
            }
            h6 {
                font-size: 13px;
            }
            hr {
                margin: 0 0 19px;
                border: 0;
                border-bottom: 1px solid #ccc;
            }
            blockquote {
                padding: 13px 13px 21px 15px;
                margin-bottom: 18px;
                font-family:georgia,serif;
                font-style: italic;
            }
            blockquote:before {
                content:"\201C";
                font-size:40px;
                margin-left:-10px;
                font-family:georgia,serif;
                color:#eee;
            }
            blockquote p {
                font-size: 14px;
                font-weight: 300;
                line-height: 18px;
                margin-bottom: 0;
                font-style: italic;
            }
            code, pre {
                font-family: Monaco, Andale Mono, Courier New, monospace;
            }
            code {
                background-color: #fee9cc;
                color: rgba(0, 0, 0, 0.75);
                padding: 1px 3px;
                font-size: 12px;
                border-radius: 3px;
            }
            pre {
                display: block;
                padding: 14px;
                margin: 0 0 18px;
                line-height: 16px;
                font-size: 11px;
                border: 1px solid #d9d9d9;
                white-space: pre-wrap;
                word-wrap: break-word;
            }
            pre code {
                background-color: #fff;
                color:#737373;
                font-size: 11px;
                padding: 0;
            }
            sup {
                font-size: 0.83em;
                vertical-align: super;
                line-height: 0;
            }
            * {
                -webkit-print-color-adjust: exact;
            }
            @media screen and (min-width: 914px) {
                body {
                    width: 854px;
                    margin:10px auto;
                }
            }
            @media print {
                body,code,pre code,h1,h2,h3,h4,h5,h6 {
                    color: black;
                }
                table, pre {
                    page-break-inside: avoid;
                }
            }                        
            iframe{
                width: 100%;
                border: 1px solid #34495E;
                margin: 0;                
            }            
            .logo{
                vertical-align: middle;
            }

        </style>        
        <script>
            function init() {
                var logoSrc = '',
                    logos = document.querySelectorAll('.logo'),
                    i = 0;
                for (; i < logos.length; i++) {
                    logos[i].src = logoSrc;
                }
                
                var iframes = document.querySelectorAll('iframe'),
                    func = function(){};
                for (i=0; i < iframes.length; i++) {
                    var iframe = iframes[i];
                    
                    // a small hack to make it work on android
                    iframe.ontouchstart = func;
                    
                    var div = document.createElement('div');
                    div.innerHTML = '<a href="' + iframe.src + '" target="_blank">独立运行→</a>';
                    iframe.parentNode.insertBefore(div, iframe);
                }   
            }
        </script>    
    </head>
    <body onload="init();">
        <a href="http://www.hightopo.com"><img class="logo"></a>HT 菜单手册
        <hr style="margin: 1px 0 20px 0">
<p>索引</p>

<ul><li><a href="#ref_description">概述</a></li><li><a href="#ref_menucustomstyle">自定义菜单样式(模拟Win7)</a></li><li><a href="#ref_menushowwithapi">调用API显示下拉菜单</a></li><li><a href="#ref_singlepageapp">单页应用实践</a></li></ul>

<hr/>

<div id="ref_description"></div>

<h3>概述</h3>

<p><code>ht.widget.Menu</code>可以为页面增加标准菜单，由一个列表<code>ul</code>和<code>ContextMenu</code>组成，借助<code>ContextMenu</code>可以实现任意层次子菜单，
图片<code>ICON</code>，<code>Check</code>多选，<code>Radio</code>单选，禁用菜单项以及自定义菜单样式等功能，<code>ContextMenu</code>的详细介绍可以参考其文档。
在正式使用<code>API</code>之前，您的页面里应该引入相关的<code>js</code>文件：</p>

<pre><code>&lt;script src=&quot;ht.js&quot;&gt;&lt;/script&gt; &lt;!--先引入ht.js--&gt;
&lt;script src=&quot;key.js&quot;&gt;&lt;/script&gt; &lt;!--快捷键常量，可以按需引入--&gt;
&lt;script src=&quot;ht-contextmenu.js&quot;&gt;&lt;/script&gt; &lt;!--依赖contextmenu--&gt;
&lt;script src=&quot;ht-menu.js&quot;&gt;&lt;/script&gt;</code></pre>

<p><code>Menu</code>提供的<code>API</code>如下：</p>

<ul><li><code>setItems(json)</code>设置菜单项，参数为<code>JSON</code>对象</li><li><code>setLayout(layout)</code> 设置布局方式，<code>largeicons</code>表示大图标模式，<code>smallicons</code>表示小图标模式，<code>iconsonly</code>表示仅图标模式</li><li><code>setHeaderItemHGap()</code> 设置根菜单项的水平间隔，默认为0，改变<code>layout</code>时可以调整此参数以达到最好的展示效果</li><li><code>setHeaderItemVGap()</code> 设置根菜单项的垂直间隔，默认为0，改变<code>layout</code>时可以调整此参数以达到最好的展示效果</li><li><code>setHeaderItemAlign()</code> 设置根菜单项的对齐方式，默认为<code>left</code>，改变<code>layout</code>时可以调整此参数以达到最好的展示效果</li><li><code>addTo(dom)</code>参数为<code>HTML</code>元素，将菜单作为其<code>child</code></li><li><code>dispose()</code>销毁此菜单</li><li><code>enableGlobalKey()</code> 启用全局快捷键，一旦启用此选项，菜单不再使用时需要显式调用<code>dispose()</code>销毁菜单</li><li><code>disableGlobalKey()</code> 禁用全局快捷键</li><li><code>setHoverBackground(color)</code> 设置鼠标划过根菜单时的背景色</li><li><code>setHoverColor(color)</code> 设置鼠标划过根菜单时的文字颜色</li><li><code>showDropdownMenu(index)</code>显示下拉菜单，参数为根菜单项的<code>index</code>，如要显示第一个根菜单项的下拉菜单，可以调用<code>showDropdownMenu(0)</code></li><li><code>hideDropdownMenu()</code>隐藏下拉菜单</li><li><code>getItemByProperty(property, value)</code>查找属性名为<code>property</code>，值为<code>value</code>的菜单项，只返回第一个查找结果，注意：如果菜单显示时修改此查找结果，则菜单界面在下次显示时更新</li><li><code>getShowingMenuIndex()</code>获得当前显示下拉菜单的根菜单项的<code>index</code>，如果没有显示下拉菜单返回<code>-1</code></li></ul>

<p>菜单的内容由一个固定格式的<code>JSON</code>对象描述，包括菜单项的文字，图片以及相应的动作，下面的<code>JSON</code>描述了一个典型菜单：</p>

<pre><code>var json = [
    {
        label: &quot;File&quot;, //菜单文字
        items: [
            {
                label: &quot;New...&quot;,
                icon: iconSrc, //菜单图片ICON
                action: function(item) { //回调函数
                    alert(item.label);
                }
            },
            {
                label: &quot;Open...&quot;,
                icon: iconSrc,
                suffix: &quot;Ctrl+O&quot;, //在菜单上显示的提示文字
                key: [Key.ctrl, Key.o], //实际响应的快捷键
                action: function(item) {
                    alert(&quot;you clicked:&quot; + item.label + &quot;,this=&quot; + this);
                },
                scope: &quot;hello&quot; //指定回调函数中的this
            },
            {
                label: &quot;Disabled&quot;,
                icon: iconSrc, 
                disabled: true //禁用菜单项
            },
            &quot;separator&quot;, //分割线
            {
                label: &quot;More...&quot;,
                icon: iconSrc,
                type: &quot;check&quot;, //可多选的菜单项
                items: [
                    {
                        label: &quot;AAAA&quot;
                    },
                    {
                        label: &quot;BBBB&quot;
                    },
                    {
                        label: &quot;CCCC&quot;
                    }
                ]
            }
        ]
    },
    {
        label: &quot;Edit&quot;,
        items:[
            {
                label: &quot;Copy&quot;,
                icon: iconSrc
            },
            {
                label: &quot;Paste&quot;,
                icon: iconSrc
            }
        ]
    },
    {
        label: &quot;CheckMenuItems&quot;,
        items: [
            {
                label: &quot;Check1&quot;,
                icon: iconSrc,
                type: &quot;check&quot;
            },
            {
                label: &quot;Check2&quot;,
                icon: iconSrc,
                type: &quot;check&quot;
            },
            {
                label: &quot;Check3&quot;,
                icon: iconSrc,
                type: &quot;check&quot;,
                items: [
                    {
                        label: &quot;AAAA&quot;
                    },
                    {
                        label: &quot;BBBB&quot;
                    },
                    {
                        label: &quot;CCCC&quot;
                    }
                ]
            }
        ],
        action: function(item) {
            alert(&quot;you clicked:&quot; + item.label + &quot;,this=&quot; + this);
        }
    },   
    {
        label: &quot;RadioMenuItems&quot;,
        action: function(item,event) {
            alert(&quot;you clicked:&quot; + item.label);
        },
        items: [
            {
                label: &quot;Radio1&quot;,
                icon: iconSrc,
                type: &quot;radio&quot;,//单选菜单项
                groupId: 1 //菜单项分组
            },
            {
                label: &quot;Radio2&quot;,
                icon: iconSrc,
                type: &quot;radio&quot;,
                groupId: 1
            },
            {
                label: &quot;Radio3&quot;,
                icon: iconSrc,
                type: &quot;radio&quot;,
                groupId: 1,
                items: [
                    {
                        label: &quot;AAAA&quot;
                    },
                    {
                        label: &quot;BBBB&quot;
                    },
                    {
                        label: &quot;CCCC&quot;
                    }
                ]
            }
        ]
    },
    {
        label: &quot;TestMenu&quot;,
        icon: iconSrc,
        action: function(item) {
            alert(item.label);
        },
        items: [
            {
                label: &quot;Homepage&quot;,
                href: &quot;http://www.hightopo.com&quot;, //超链到某个URL
                linkTarget: &quot;_blank&quot;, //超链目标，默认_self
                key: [Key.meta, Key.enter], //实际响应的快捷键
                suffix: &quot;Command+Enter&quot;, //在菜单上显示的提示文字
                preventDefault: false //是否阻止快捷键默认的行为，默认为true
            },
            {
                label: &quot;submenu&quot;,
                action: function(item) {
                    alert(item.label);
                }
            }
        ]
    }
];</code></pre>

<p>这个<code>JSON</code>对象渲染出来的菜单见下例：</p>

<p><iframe src="examples/example_base.html" style="height:200px"></iframe></p>

<div id="ref_menucustomstyle"></div>

<h3>自定义菜单样式(模拟Win7)</h3>

<p>和右键菜单类似，菜单支持通过全局的<code>htconfig</code>配置风格样式，可配置的参数如下：</p>

<ul><li><code>menuLabelFont</code> 菜单文字字体，默认为<code>(isTouchable ? &#39;16&#39; : &#39;13&#39;) + &#39;px arial, sans-serif&#39;</code>,</li><li><code>menuLabelColor</code> 菜单文字颜色，默认为<code>#000</code>,</li><li><code>menuBackground</code> 菜单背景色，默认为<code>#F0EFEE</code></li><li><code>menuHoverBackground</code> 鼠标划过菜单项时的背景颜色，默认为<code>#648BFE</code></li><li><code>menuHoverLabelColor</code> 鼠标划过菜单项时的文字颜色，默认为<code>#fff</code></li><li><code>menuSeparatorWidth</code> 菜单底部分割线的宽度，默认为<code>1</code></li><li><code>menuSeparatorColor</code> 菜单底部分割线的颜色，默认为<code>#999</code></li></ul>

<p>除了<code>htconfig</code>对象，也可以使用<code>css</code>覆盖默认的风格，请参考下面的例子：</p>

<p><iframe src="examples/example_customstyle.html" style="height:200px"></iframe></p>

<div id="ref_menushowwithapi"></div>

<h3>调用API显示下拉菜单</h3>

<p>通常下拉菜单通过点击触发显示即可，除此之外，<code>Menu</code>也支持通过<code>API</code>控制显示和隐藏下拉菜单：</p>

<p><iframe src="examples/example_showwithapi.html" style="height:250px"></iframe></p>

<pre><code>&lt;input type=&quot;button&quot; value=&quot;Show&quot; onclick=&quot;window.menu.showDropdownMenu(document.getElementById(&#39;txt&#39;).value);&quot;&gt;
&lt;input type=&quot;button&quot; value=&quot;Hide&quot; onclick=&quot;window.menu.hideDropdownMenu();&quot;&gt;
&lt;input type=&quot;button&quot; value=&quot;PrintIndex&quot; onmousedown=&quot;alert(window.menu.getShowingMenuIndex());&quot;&gt;</code></pre>

<div id="ref_singlepageapp"></div>

<h3>单页应用实践</h3>

<p>通俗来说，单页应用是让用户在一个页面中完成所有的操作，它的介绍可以参考这里：<a href="http://en.wikipedia.org/wiki/Single-page_application">Single-page application</a>，
对于一个附带标准菜单的应用，通常需要将菜单放置到页面顶部，然后用其它组件填满剩下的区域，我们接下来模拟这样的功能：</p>

<p><iframe src="examples/example_spa.html" style="height:250px"></iframe></p>    <hr id="contact" style="margin: 20px 0 1px 0">
    <a href="http://www.hightopo.com"><img class="logo"></a>欢迎交流 <a href="mailto:service@hightopo.com">service@hightopo.com</a>
</body>
</html>
